> ## Documentation Index
> Fetch the complete documentation index at: https://sequence-0fb8d9e6-api_docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# useSelectPaymentModal

> Hook for opening the payment selection modal

## Import

```tsx theme={null}
import { useSelectPaymentModal } from '@0xsequence/checkout'
```

## Usage

```typescript [abis/mintFunctionAbi.ts] theme={null}
const mintFunctionAbi = {
        type: 'function',
        name: 'mint',
        inputs: [
            {
                name: 'to',
                type: 'address',
                internalType: 'address'
            },
            {
                name: 'tokenIds',
                type: 'uint256[]',
                internalType: 'uint256[]'
            },
            {
                name: 'amounts',
                type: 'uint256[]',
                internalType: 'uint256[]'
            },
            {
                name: 'data',
                type: 'bytes',
                internalType: 'bytes'
            },
            {
                name: 'expectedPaymentToken',
                type: 'address',
                internalType: 'address'
            },
            {
                name: 'maxTotal',
                type: 'uint256',
                internalType: 'uint256'
            },
            {
                name: 'proof',
                type: 'bytes32[]',
                internalType: 'bytes32[]'
            }
        ],
        outputs: [],
        stateMutability: 'payable'
    }
```

```tsx [components/BuyNFT.tsx] theme={null}
import { useSelectPaymentModal } from '@0xsequence/checkout'
import { encodeFunctionData, toHex } from 'viem'
import { useAccount } from 'wagmi'
import { mintFunctionAbi } from '../abis/erc1155'

function BuyNFT() {
    const { address } = useAccount()
    const { openSelectPaymentModal } = useSelectPaymentModal()

    const handleCheckout = () => {
        if (!address) return

        // ERC-20 payment settings
        const currencyAddress = '0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359' // USDC on Polygon
        const salesContractAddress = '0xe65b75eb7c58ffc0bf0e671d64d0e1c6cd0d3e5b'
        const collectionAddress = '0xdeb398f41ccd290ee5114df7e498cf04fac916cb'
        const price = '20000' // Price in smallest unit (0.02 USDC)
        const chainId = 137 // Polygon

        // NFT details
        const collectibles = [
            {
                tokenId: '1',
                quantity: '1'
            }
        ]

        // Transaction data for the ERC-1155 mint function
        const purchaseTransactionData = encodeFunctionData({
            abi: [mintFunctionAbi],
            functionName: 'mint',
            args: [
                address,
                collectibles.map(c => BigInt(c.tokenId)),
                collectibles.map(c => BigInt(c.quantity)),
                toHex(0),
                currencyAddress,
                price,
                [toHex(0, { size: 32 })]
            ]
        })

        // Open the payment selection modal
        openSelectPaymentModal({
            collectibles,
            chain: chainId,
            price,
            targetContractAddress: salesContractAddress,
            recipientAddress: address,
            currencyAddress,
            collectionAddress,
            creditCardProviders: ['transak'],
            onSuccess: (txnHash: string) => {
                console.log('success!', txnHash)
            },
            onError: (error: Error) => {
                console.error(error)
            },
            onClose: () => {
                console.log('modal closed!')
            },
            txData: purchaseTransactionData
        })
    }

    return (
        <button onClick={handleCheckout}>
            Buy NFT with multiple payment options
        </button>
    )
}

export default BuyNFT
```

<img src="https://mintcdn.com/sequence-0fb8d9e6-api_docs/1DaXG5kl_9aVymNt/images/sdk/Checkout_SelectPaymentModal.png?fit=max&auto=format&n=1DaXG5kl_9aVymNt&q=85&s=5e8c8acd9f95749a50adced604813b10" alt="Payment Selection Modal" height="200" className="rounded-lg" data-path="images/sdk/Checkout_SelectPaymentModal.png" />

## Return Type: `UseSelectPaymentModalReturnType`

The hook returns an object with the following properties:

```tsx theme={null}
type UseSelectPaymentModalReturnType = {
  openSelectPaymentModal: (settings: SelectPaymentSettings) => void
  closeSelectPaymentModal: () => void
  selectPaymentSettings: SelectPaymentSettings | undefined
}
```

### Properties

#### openSelectPaymentModal

`(settings: SelectPaymentSettings) => void`

Function to open the Payment Selection modal with the specified settings.

**Parameters:**

The `settings` object can include the following properties:

| Parameter               | Type                                         | Description                                               |
| ----------------------- | -------------------------------------------- | --------------------------------------------------------- |
| `collectibles`          | `Array<{tokenId: string, quantity: string}>` | Array of collectibles to purchase                         |
| `chain`                 | `number`                                     | Blockchain network ID                                     |
| `price`                 | `string`                                     | Price in smallest unit of the currency                    |
| `targetContractAddress` | `string`                                     | Address of the contract to interact with                  |
| `recipientAddress`      | `string`                                     | Address to receive the purchased items                    |
| `currencyAddress`       | `string`                                     | Address of the currency token contract                    |
| `collectionAddress`     | `string`                                     | Address of the NFT collection contract                    |
| `creditCardProviders`   | `string[]`                                   | List of supported credit card providers (e.g., 'transak') |
| `copyrightText`         | `string`                                     | Copyright text to display in the modal                    |
| `onSuccess`             | `(txnHash: string) => void`                  | Callback when transaction succeeds                        |
| `onError`               | `(error: Error) => void`                     | Callback when an error occurs                             |
| `onClose`               | `() => void`                                 | Callback when the modal is closed                         |
| `txData`                | `string`                                     | Encoded transaction data for the purchase                 |

#### closeSelectPaymentModal

`() => void`

Function to close the Payment Selection modal.

#### selectPaymentSettings

`SelectPaymentSettings | undefined`

The current settings configuration for the Payment Selection modal.

## Notes

This hook provides methods to control the Payment Selection modal that allows users to purchase digital assets with multiple payment options. The modal offers various payment methods including:

* Pay with cryptocurrency from the user's wallet
* Swap tokens to pay with a different cryptocurrency
* Pay with credit/debit card
* Receive funds from another wallet